版本：V4.0

訂單管理API

獲取訂單列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
order_id	String	Body	訂單ID
order_number	String	Body	訂單編號
residence_id	String	Body	住宅ID
residence_no	String	Body	住宅號碼
room_type_id	String	Body	房間類型ID
room_type_name	String	Body	房間類型名稱
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
order_state	String	Body	訂單狀態 check_in：未入住 checked_in：已入住 checked_out：已退房
guests	[]Object<guest>	Body	客人信息

guest說明

參數名	類型	位置	說明
guest_id	String	Body	客人ID
guest_name	String	Body	客人名稱
email	String	Body	郵箱
phone	String	Body	電話
id_card	String	Body	身份證
passport	String	Body	護照

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_order_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "order_id": "orx9a621c1ae77040d697bd2134700f57",
      "order_number": "20250725064924573999",
      "residence_id": "rorx9a621c1ae77040d697bd2134700f5",
      "residence_no": "101",
      "room_type_id": "rorx9a621c1ae77040d697bd2134700fg",
      "room_type_name": "test",
      "start_time": "2025-08-06 03:00:03",
      "end_time": "2025-08-06 03:30:03",
      "order_state": "check_in",
      "guests": [
        {
          "guest_id": "gorx9a621c1ae77040d697bd2134700f5",
          "guest_name": "dom",
          "email": "test@akubela.com",
          "phone": "1234567",
          "id_card": "1234567890",
          "passport": ""
        }
      ]
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取訂單信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
order_id	String	Body	是	訂單ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
order_number	String	Body	訂單編號
residence_id	String	Body	住宅ID
residence_no	String	Body	住宅號碼
room_type_id	String	Body	房間類型ID
room_type_name	String	Body	房間類型名稱
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
order_state	String	Body	訂單狀態 check_in：未入住 checked_in：已入住 checked_out：已退房
guests	[]Object<guest>	Body	客人信息
source	String	Body	來源
remark	String	Body	備註
enable_booking	Boolean	Body	判斷是否啓用預約服務 true：啓用 false：禁用

guest說明

參數名	類型	位置	說明
guest_id	String	Body	客人ID
guest_name	String	Body	客人名稱
email	String	Body	郵箱
phone	String	Body	電話
id_card	String	Body	身份證
passport	String	Body	護照

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_order_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "order_id": "orx9a621c1ae77040d697bd2134700f57"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "order_number": "20250725064924573999",
    "residence_id": "rorx9a621c1ae77040d697bd2134700f5",
    "residence_no": "101",
    "room_type_id": "rorx9a621c1ae77040d697bd2134700fg",
    "room_type_name": "test",
    "start_time": "2025-08-06 03:00:03",
    "end_time": "2025-08-06 03:30:03",
    "order_state": "check_in",
    "source": "SaaS",
    "remark": "",
    "enable_booking": false,
    "guests": [
      {
        "guest_id": "gorx9a621c1ae77040d697bd2134700f5",
        "guest_name": "dom",
        "email": "test@akubela.com",
        "phone": "1234567",
        "id_card": "1234567890",
        "passport": ""
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

創建訂單信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC
guest	Object<guest>	Body	是	客人信息
source	String	Body	是	來源
remark	String	Body	是	備註
enable_booking	Boolean	Body	是	判斷是否啓用預約服務 true：啓用 false：禁用

guest說明

參數名	類型	位置	必填	說明
guest_name	String	Body	是	客人名稱
email	String	Body	是	郵箱
phone	String	Body	是	電話
id_card	String	Body	是	身份證
passport	String	Body	是	護照

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
order_id	String	Body	訂單ID
order_number	String	Body	訂單編號
guest_id	String	Body	客人ID

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_order_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "rorx9a621c1ae77040d697bd2134700f5",
    "start_time": "2025-08-06 03:00:03",
    "end_time": "2025-08-06 03:30:03",
    "source": "SaaS",
    "remark": "",
    "enable_booking": false,
    "guest": {
      "guest_name": "dom",
      "email": "test@akubela.com",
      "phone": "1234567",
      "id_card": "1234567890",
      "passport": ""
    }
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "order_id": "r2a621c1ae77040d697bd2134700f57e2",
    "order_number": "20250725064924573993",
    "guest_id": "gorx9a621c1ae77040d697bd2134700f5"
  }
}

失敗返回示例

見接口失敗返回

更新訂單信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
order_id	String	Body	是	訂單ID
residence_id	String	Body	是	住宅ID
room_type_id	String	Body	是	房間類型ID
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC
order_state	String	Body	是	訂單狀態 check_in：未入住 checked_in：已入住 checked_out：已退房
source	String	Body	是	來源
remark	String	Body	是	備註
enable_booking	Boolean	Body	是	判斷是否啓用預約服務 true：啓用 false：禁用

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_order_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "order_id": "o2a621c1ae77040d697bd2134700f57e1",
    "residence_id": "rorx9a621c1ae77040d697bd2134700f5",
    "room_type_id": "rorx9a621c1ae77040d697bd2134700fg",
    "start_time": "2025-08-06 03:00:03",
    "end_time": "2025-08-06 03:30:03",
    "order_state": "check_in",
    "source": "SaaS",
    "remark": "",
    "enable_booking": false
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

刪除訂單信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
order_id	String	Body	是	訂單ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_order_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "order_id": "orbr2c4b070cc928496198944858b343f"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取訂單列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

guest說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取訂單信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

guest說明​

請求示例​

成功返回示例​

失敗返回示例​

創建訂單信息​

接口地址​

請求參數​

param說明​

guest說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

更新訂單信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除訂單信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

獲取訂單列表

接口地址

請求參數

param說明

返回參數

result說明

guest說明

請求示例

成功返回示例

失敗返回示例

獲取訂單信息

接口地址

請求參數

param說明

返回參數

result說明

guest說明

請求示例

成功返回示例

失敗返回示例

創建訂單信息

接口地址

請求參數

param說明

guest說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

更新訂單信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除訂單信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例